Class Document

Document

Un document contenant un ou plusieurs objets Tab, chacun contenant du texte enrichi et tels que des tableaux et des listes.

Vous pouvez ouvrir ou créer des documents avec DocumentApp. 

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

Les méthodes de la classe Document qui accèdent directement au contenu textuel et le modifient opèrent soit l'onglet actif (dans les scripts liés à un (document en particulier) ou le premier onglet (si aucun document actif n'est disponible). Les scripts s'appuyant sur ces méthodes (par exemple, getBody()) peuvent être migrées vers les onglets d'assistance à l'aide de getTabs(), puis Tab.asDocumentTab().

Méthodes

MéthodeType renvoyéBrève description
addBookmark(position)BookmarkAjoute un Bookmark au niveau de la Position donnée du premier onglet ou, pour les scripts qui sont lié à un document, l'onglet actif.
addEditor(emailAddress)DocumentAjoute l'utilisateur donné à la liste des éditeurs de Document.
addEditor(user)DocumentAjoute l'utilisateur donné à la liste des éditeurs de Document.
addEditors(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des éditeurs pour Document.
addFooter()FooterSectionAjoute une section de pied de page, le cas échéant, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
addHeader()HeaderSectionAjoute une section d'en-tête, le cas échéant, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
addNamedRange(name, range)NamedRangeAjoute un NamedRange, qui est un Range dont le nom et l'ID sont à utiliser pour par la suite, dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif.
addViewer(emailAddress)DocumentAjoute l'utilisateur donné à la liste des lecteurs de Document.
addViewer(user)DocumentAjoute l'utilisateur donné à la liste des lecteurs de Document.
addViewers(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des lecteurs pour Document.
getActiveTab()TabRécupère les Tab actuellement actifs de l'utilisateur dans le document.
getAs(contentType)BlobRécupère le contenu Document actuel sous la forme d'un blob du type spécifié.
getBlob()BlobRécupère le contenu actuel de Document sous forme de blob.
getBody()BodyRécupère l'Body du premier onglet ou, pour les scripts liés à un document, le DocumentBodySection de l'onglet actif.
getBookmark(id)BookmarkRécupère le Bookmark avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, l'onglet actif.
getBookmarks()Bookmark[]Récupère tous les objets Bookmark du premier onglet ou, pour les scripts liés à un document, l'onglet actif.
getCursor()PositionRécupère le curseur de l'utilisateur dans l'onglet actif.
getEditors()User[]Récupère la liste des éditeurs pour cet élément Document.
getFooter()FooterSectionRécupère la section du pied de page du premier onglet ou, pour les scripts qui sont liés à un document, le pied de page de l'onglet actif. .
getFootnotes()Footnote[]Récupère tous les éléments Footnote dans le corps du premier onglet ou, pour les scripts liés à un document, dans le corps de l'onglet actif.
getHeader()HeaderSectionRécupère la section d'en-tête du premier onglet ou, pour les scripts liés à un document, l'en-tête de l'onglet actif. .
getId()StringRécupère l'identifiant unique du document.
getLanguage()StringRécupère le code de langue du document.
getName()StringRécupère le titre du document.
getNamedRangeById(id)NamedRangeRécupère le NamedRange avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, l'onglet actif.
getNamedRanges()NamedRange[]Récupère tous les objets NamedRange du premier onglet ou, pour les scripts liés à un document, l'onglet actif.
getNamedRanges(name)NamedRange[]Récupère tous les objets NamedRange portant le nom donné dans le premier onglet ou, pour les scripts qui sont liés à un document, l'onglet actif.
getSelection()RangeRécupère la sélection de l'utilisateur dans l'onglet actif.
getSupportedLanguageCodes()String[]Récupère tous les codes de langue acceptés dans les fichiers Google Docs.
getTab(tabId)TabRécupère l'élément Tab avec l'ID spécifié.
getTabs()Tab[]Récupère tous les éléments Tab non imbriqués qui font partie du document.
getUrl()StringRécupère l'URL permettant d'accéder au document actuel.
getViewers()User[]Récupère la liste des lecteurs et des commentateurs de Document.
newPosition(element, offset)PositionCrée un Position, qui est une référence à un emplacement dans l'onglet, par rapport à élément spécifique du premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
newRange()RangeBuilderCrée un compilateur pour construire des objets Range à partir des éléments d'onglet dans premier onglet ou, pour les scripts liés à un l'onglet actif.
removeEditor(emailAddress)DocumentSupprime l'utilisateur indiqué de la liste des éditeurs pour Document.
removeEditor(user)DocumentSupprime l'utilisateur indiqué de la liste des éditeurs pour Document.
removeViewer(emailAddress)DocumentSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour Document.
removeViewer(user)DocumentSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour Document.
saveAndClose()voidEnregistre la Document actuelle.
setActiveTab(tabId)voidDéfinit le Tab sélectionné par l'utilisateur dans le document actuel sur l'onglet portant l'ID spécifié.
setCursor(position)DocumentDéfinit le curseur de l'utilisateur en fonction d'un Position.
setLanguage(languageCode)DocumentDéfinit le code de langue du document.
setName(name)DocumentDéfinit le titre du document.
setSelection(range)DocumentDéfinit la sélection de l'utilisateur dans l'onglet actif en fonction d'un Range.

Documentation détaillée

addBookmark(position)

Ajoute un Bookmark au niveau de la Position donnée du premier onglet ou, pour les scripts qui sont lié à un document, l'onglet actif. Pour ajouter un Ajoutez un favori à n'importe quel onglet, utilisez la méthode DocumentTab.addBookmark(position). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

}

Paramètres

NomTypeDescription
positionPositionPosition du nouveau favori.

Renvois

Bookmark : nouveau favori

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(emailAddress)

Ajoute l'utilisateur donné à la liste des éditeurs de Document. Si l'utilisateur était déjà dans la liste des lecteurs, cette méthode met l'utilisateur hors de la liste des lecteurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Renvois

Document : Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(user)

Ajoute l'utilisateur donné à la liste des éditeurs de Document. Si l'utilisateur était déjà dans la liste des lecteurs, cette méthode met l'utilisateur hors de la liste des lecteurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

Document : Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditors(emailAddresses)

Ajoute le tableau d'utilisateurs donné à la liste des éditeurs pour Document. Si l'une des valeurs que les utilisateurs figuraient déjà dans la liste des lecteurs, cette méthode les met en retrait de la liste les lecteurs.

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

Document : Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addFooter()

Ajoute une section de pied de page, le cas échéant, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif. Pour ajouter un pied de page : à n'importe quel onglet, utilisez la méthode DocumentTab.addFooter(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Renvois

FooterSection : pied de page de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addHeader()

Ajoute une section d'en-tête, le cas échéant, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif. Pour ajouter un en-tête à n'importe quel onglet, utilisez la méthode DocumentTab.addHeader(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Renvois

HeaderSection : en-tête de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addNamedRange(name, range)

Ajoute un NamedRange, qui est un Range dont le nom et l'ID sont à utiliser pour par la suite, dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif. Pour ajouter un NamedRange dans n'importe quel onglet, utilisez la méthode DocumentTab.addNamedRange(name, range). Les noms ne sont pas nécessairement uniques ; plusieurs plages différentes d'un même document peuvent porter le même nom, comme une classe en HTML. En revanche, les ID sont uniques dans le document, comme un ID en HTML. Une fois que vous avez ajouté une NamedRange à un document, vous ne pouvez plus la modifier. Vous pouvez seulement la supprimer.

Tout script qui accède au document peut accéder à un NamedRange. Pour éviter les actions involontaires des conflits entre les scripts, envisagez de faire précéder les noms de plage par une chaîne unique. 

// Creates a named range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

Paramètres

NomTypeDescription
nameStringLe nom de la plage, qui n'a pas besoin d'être unique. les noms de plage doivent être comportant entre 1 et 256 caractères.
rangeRangePlage d'éléments à associer au nom. la plage peut être la sélection active, un résultat de recherche ou être créée manuellement avec newRange().

Renvois

NamedRange : NamedRange.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(emailAddress)

Ajoute l'utilisateur donné à la liste des lecteurs de Document. Si l'utilisateur était déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Renvois

Document : Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(user)

Ajoute l'utilisateur donné à la liste des lecteurs de Document. Si l'utilisateur était déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

Document : Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewers(emailAddresses)

Ajoute le tableau d'utilisateurs donné à la liste des lecteurs pour Document. Si l'une des valeurs si des utilisateurs figuraient déjà dans la liste des éditeurs, cette méthode n'a aucun effet pour eux.

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

Document : Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getActiveTab()

Récupère les Tab actuellement actifs de l'utilisateur dans le document. Un script ne peut accéder qu'au onglet actif de l'utilisateur qui exécute le script, et uniquement si le script est lié au document. 

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert('ID of selected tab: ' + tab.getTitle());

Renvois

Tab : Tab actif de l'utilisateur ou null si le script n'est pas lié à le document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAs(contentType)

Récupère le contenu Document actuel sous la forme d'un blob du type spécifié. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

Paramètres

NomTypeDescription
contentTypeStringType MIME pour la conversion. 'application/pdf' et 'text/markdown' sont acceptés.

Renvois

Blob : document actuel sous forme de blob.

getBlob()

Récupère le contenu actuel de Document sous forme de blob. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

Renvois

Blob : document actuel sous forme de blob.

getBody()

Récupère l'Body du premier onglet ou, pour les scripts liés à un document, le DocumentBodySection de l'onglet actif. Pour obtenir le DocumentBodySection de n'importe quel onglet, utilisez la méthode DocumentTab.getBody().

Les onglets peuvent contenir différents types de sections (par exemple, HeaderSection ou FooterSection). La section active d'un onglet est Body.

Les méthodes d'élément dans Document délèguent à l'élément Body actif. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Renvois

Body : section du corps de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmark(id)

Récupère le Bookmark avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, l'onglet actif. Pour obtenir un ajoutez un favori dans n'importe quel onglet, utilisez la méthode DocumentTab.getBookmark(id). Cette méthode renvoie null si aucun Bookmark de ce type n'existe dans l'onglet. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the console.
// otherwise, logs 'No bookmark exists with the given ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Paramètres

NomTypeDescription
idStringID de l'élément Bookmark.

Renvois

Bookmark : Bookmark avec l'ID donné, ou null en l'absence de Bookmark existe dans l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmarks()

Récupère tous les objets Bookmark du premier onglet ou, pour les scripts liés à un document, l'onglet actif. Pour obtenir les favoris de n'importe quel onglet, utilisez la méthode DocumentTab.getBookmarks(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

Renvois

Bookmark[] : tableau des objets Bookmark dans l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getCursor()

Récupère le curseur de l'utilisateur dans l'onglet actif. Un script peut uniquement accéder au curseur de l'utilisateur qui exécute le script, et uniquement s'il est lié au document. 

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Renvois

Position : représentation du curseur de l'utilisateur, ou null si l'utilisateur n'a pas de curseur placé dans l'onglet ou si le script n'est pas lié au document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getEditors()

Récupère la liste des éditeurs pour cet élément Document.

Renvois

User[] : tableau d'utilisateurs disposant de droits de modification.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFooter()

Récupère la section du pied de page du premier onglet ou, pour les scripts qui sont liés à un document, le pied de page de l'onglet actif. . Pour obtenir la section de pied de page de n'importe quel onglet, utilisez la méthode DocumentTab.getFooter(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

Renvois

FooterSection : pied de page de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFootnotes()

Récupère tous les éléments Footnote dans le corps du premier onglet ou, pour les scripts liés à un document, dans le corps de l'onglet actif. Pour obtenir toutes les notes de bas de page de n'importe quel onglet, utilisez la méthode DocumentTab.getFootnotes().

Les appels à getFootnotes entraînent une itération sur les éléments de l'onglet. Pour les grands onglets, évitez les appels inutiles à cette méthode. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Renvois

Footnote[] : notes de bas de page de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getHeader()

Récupère la section d'en-tête du premier onglet ou, pour les scripts liés à un document, l'en-tête de l'onglet actif. . Pour obtenir la section d'en-tête de n'importe quel onglet, utilisez la méthode DocumentTab.getHeader(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

Renvois

HeaderSection : en-tête de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getId()

Récupère l'identifiant unique du document. L'ID du document est utilisé avec DocumentApp.openById() pour ouvrir une instance de document spécifique.

Renvois

String : ID du document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getLanguage()

Récupère le code de langue du document. Il s'agit de la langue affichée dans la section Fichier &gt; Langue, qui peut ne pas correspondre à la langue du document.

Renvois

String : langue du document, ou null si non défini.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getName()

Récupère le titre du document.

Renvois

String : titre du document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRangeById(id)

Récupère le NamedRange avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, l'onglet actif. Pour obtenir NamedRange avec l'ID donné dans n'importe quel onglet, utilisez DocumentTab.getNamedRangeById(id). . Cette méthode renvoie null si aucun NamedRange de ce type n'existe dans l'onglet. Noms ne sont pas forcément uniques, même dans plusieurs onglets ; plusieurs plages dans le même onglet peuvent portent le même nom, un peu comme une classe en HTML. En revanche, les identifiants sont uniques dans l'onglet, comme un ID en HTML.

Paramètres

NomTypeDescription
idStringIdentifiant de la plage, qui est unique dans l'onglet.

Renvois

NamedRange : NamedRange avec l'ID donné ou null si aucune plage de ce type n'existe dans l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges()

Récupère tous les objets NamedRange du premier onglet ou, pour les scripts liés à un document, l'onglet actif. Pour obtenir NamedRange dans n'importe quel onglet, utilisez la méthode DocumentTab.getNamedRanges().

Un NamedRange est accessible par n'importe quel script qui accède à l'onglet. Pour éviter des conflits inattendus entre les scripts, envisagez de préfixer les noms de plage avec une chaîne unique.

Renvois

NamedRange[] : tableau des objets NamedRange de l'onglet, pouvant inclure plusieurs plages portant le même nom.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges(name)

Récupère tous les objets NamedRange portant le nom donné dans le premier onglet ou, pour les scripts qui sont liés à un document, l'onglet actif. Pour obtenir tous les objets NamedRange de n'importe quel onglet, utilisez la méthode DocumentTab.getNamedRanges(name). Les noms ne sont pas nécessairement uniques, même d'un onglet à l'autre. plusieurs plages différentes dans un même onglet peut porter le même nom, tout comme une classe en HTML. À l'inverse, les identifiants sont uniques dans l'onglet, comme un ID en HTML.

Un NamedRange est accessible par tout script qui accède au document. Pour éviter des conflits inattendus entre les scripts, envisagez de préfixer les noms de plage avec une chaîne unique.

Paramètres

NomTypeDescription
nameStringNom de la plage, qui n'est pas nécessairement unique.

Renvois

NamedRange[] : tableau des objets NamedRange de l'onglet portant le nom donné.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSelection()

Récupère la sélection de l'utilisateur dans l'onglet actif. Un script ne peut accéder qu'à la sélection de l'utilisateur qui exécute le script, et uniquement s'il est lié au document. 

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var elements = selection.getRangeElements();
  DocumentApp.getUi().alert('Number of selected elements: ' + elements.length);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

Renvois

Range : représentation de la sélection de l'utilisateur, ou null si l'utilisateur n'a pas tout élément sélectionné dans l'onglet, si seule la fin d'un paragraphe est sélectionnée, si seule la fin d'un paragraphe et une nouvelle ligne sont sélectionnés, ou si le script n'est pas lié au document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSupportedLanguageCodes()

Récupère tous les codes de langue acceptés dans les fichiers Google Docs.

Renvois

String[] : tableau de codes de langue.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTab(tabId)

Récupère l'élément Tab avec l'ID spécifié. Cette méthode renvoie null si aucun Tab de ce type n'existe. Peut accéder aux onglets à n'importe quel niveau d'imbrication.

Paramètres

NomTypeDescription
tabIdStringID de l'onglet à obtenir.

Renvois

Tab : Tab avec l'ID spécifié ou null si aucun Tab de ce type n'existe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTabs()

Récupère tous les éléments Tab non imbriqués qui font partie du document.

Les onglets peuvent contenir des onglets enfants, qui sont imbriqués dans un autre onglet. Les onglets enfants sont accessibles avec Tab.getChildTabs().

Renvois

Tab[] : liste de tous les Tab qui font partie du document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getUrl()

Récupère l'URL permettant d'accéder au document actuel. 

var doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());

Renvois

String : URL permettant d'accéder au document actif.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getViewers()

Récupère la liste des lecteurs et des commentateurs de Document.

Renvois

User[] : tableau d'utilisateurs disposant d'autorisations d'affichage ou de commentaires.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newPosition(element, offset)

Crée un Position, qui est une référence à un emplacement dans l'onglet, par rapport à élément spécifique du premier onglet ou, pour les scripts liés à un document, à l'onglet actif. Pour créer un Position par rapport à un emplacement dans n'importe quel onglet, utilisez la DocumentTab.newPosition(element, offset) . Le curseur de l'utilisateur est, entre autres, représenté sous forme de Position. 

// Append a paragraph to the active tab, then place the user's cursor after the first word of
// the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Paramètres

NomTypeDescription
elementElementL'élément qui doit contenir le nouveau Position. il doit s'agir Text ou un élément conteneur comme Paragraph.
offsetIntegerPour les éléments Text, le nombre de caractères avant Position. Pour les autres éléments, le nombre d'éléments enfants avant Position dans la le même élément conteneur.

Renvois

Position : nouveau Position.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newRange()

Crée un compilateur pour construire des objets Range à partir des éléments d'onglet dans premier onglet ou, pour les scripts liés à un l'onglet actif. Pour créer un compilateur utilisé pour construire des objets DocumentRange à partir des éléments de n'importe quel onglet, utilisez la méthode DocumentTab.newRange(). 

// Change the user's selection to a range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Renvois

RangeBuilder : nouveau compilateur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(emailAddress)

Supprime l'utilisateur indiqué de la liste des éditeurs pour Document. Cette méthode ne permet pas empêcher les utilisateurs d'accéder au Document s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple, si le Document est partagé avec l'ensemble domaine, ou si Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également supprimé de la liste des lecteurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Renvois

Document : Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(user)

Supprime l'utilisateur indiqué de la liste des éditeurs pour Document. Cette méthode ne permet pas empêcher les utilisateurs d'accéder au Document s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple, si le Document est partagé avec l'ensemble domaine, ou si Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également supprimé de la liste des lecteurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

Document : Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(emailAddress)

Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour Document. Ce n'a aucun effet si l'utilisateur est un éditeur, et non un lecteur ou un commentateur. Cette méthode permet également n'empêche pas les utilisateurs d'accéder au Document s'ils appartiennent à une classe d'utilisateurs qui disposer d'un accès général (par exemple, si le Document est partagé avec le compte l'ensemble du domaine, ou si le Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également supprimé de la liste des éditeurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Renvois

Document : Document pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(user)

Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour Document. Ce n'a aucun effet si l'utilisateur est un éditeur et non un lecteur. Cette méthode ne bloque pas non plus utilisateurs d'accéder à Document s'ils appartiennent à une classe d'utilisateurs ayant des droits d'accès l'accès, par exemple si le Document est partagé avec l'ensemble du domaine de l'utilisateur ; si Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également supprimé de la liste des éditeurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

Document : Document pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

saveAndClose()

Enregistre la Document actuelle. Entraîne le vidage et l'application des mises à jour en attente.

La méthode saveAndClose() est automatiquement appelée à la fin de l'exécution du script. pour chaque Document modifiable ouvert.

Impossible de modifier un élément Document fermé. Utilisez DocumentApp.openById() pour rouvrir un un document donné pour le modifier.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setActiveTab(tabId)

Définit le Tab sélectionné par l'utilisateur dans le document actuel sur l'onglet portant l'ID spécifié. 

const doc = DocumentApp.getActiveDocument()

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab(TAB_ID);

Paramètres

NomTypeDescription
tabIdStringID de l'onglet à définir comme actif.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setCursor(position)

Définit le curseur de l'utilisateur en fonction d'un Position. Un script ne peut accéder qu'au curseur du Utilisateur qui exécute le script, et uniquement si celui-ci est lié au document.

Fournir un Position à partir d'un Tab inactif modifie l'onglet actif de l'utilisateur. 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Paramètres

NomTypeDescription
positionPositionNouvel emplacement du curseur.

Renvois

Document : Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setLanguage(languageCode)

Définit le code de langue du document. Il s'agit de la langue affichée dans la section Fichier &gt; Langue, qui peut ne pas correspondre à la langue du document. Utilisez getSupportedLanguageCodes() pour obtenir tous les codes de langue valides.

Paramètres

NomTypeDescription
languageCodeStringCode de langue.

Renvois

Document : Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setName(name)

Définit le titre du document.

Paramètres

NomTypeDescription
nameStringTitre du nouveau document.

Renvois

Document : document actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setSelection(range)

Définit la sélection de l'utilisateur dans l'onglet actif en fonction d'un Range. Un script ne peut accéder à la sélection de l'utilisateur qui exécute le script, et uniquement si celui-ci est lié au document ; 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the document.
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Paramètres

NomTypeDescription
rangeRangeNouvelle plage d'éléments à sélectionner.

Renvois

Document : Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents